home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / c / Hash_PrintStats.man < prev    next >
Encoding:
Text File  |  1988-12-30  |  1.6 KB  |  50 lines
  1. ' $Header: /sprite/src/lib/c/hash/RCS/Hash_PrintStats.man,v 1.1 88/12/30 15:05:25 ouster Exp $ SPRITE (Berkeley)
  2. .so \*(]ltmac.sprite
  3. .HS Hash_PrintStats lib
  4. .BS
  5. .SH NAME
  6. Hash_PrintStats \- print statistics about a hash table 
  7. .SH SYNOPSIS
  8. \fB#include <hash.h>\fR
  9. .sp
  10. \fBHash_PrintStats\fR(\fItablePtr, proc, clientData\fR)
  11. .AS ClientData clientData
  12. .SH ARGUMENTS
  13. .AP Hash_Table *tablePtr in
  14. Table about which to print information.
  15. .AP void (*proc)() in
  16. Procedure to call to actually print information.
  17. .AP ClientData clientData in
  18. Arbitrary additional argument to be passed to \fIproc\fP.
  19. .BE
  20.  
  21. .SH DESCRIPTION
  22. .LP
  23. \fBHash_PrintStats\fR prints out statistical information about bucket
  24. usage in \fItablePtr\fP.  The information includes the total number
  25. of buckets and entries in the table, plus a histogram indicating
  26. how many buckets have each different number of entries in them.
  27. .LP
  28. \fBHash_PrintStats\fR does not output the statistics information directly.
  29. Instead, it invokes \fIproc\fP to do the output.  Proc must
  30. have the following calling sequence:
  31. .DS
  32. .ta 1c 2c 3c
  33. void
  34. proc(\fIclientData, string\fP)
  35.     ClientData \fIclientData\fP;
  36.     char *\fIstring\fP;
  37. {
  38. }
  39. .DE
  40. .LP
  41. The \fIclientData\fP parameter will be the same as the \fIclientData\fP
  42. to \fBHash_PrintStats\fR;  ostensibly it provides information to help \fIproc\fP
  43. perform the actual I/O, such as channel number.  \fIString\fP is
  44. a NULL-terminated string of characters containing the statistical
  45. information.  \fIProc\fP may be invoked many times during a single
  46. call to \fBHash_PrintStats\fR.
  47.  
  48. .SH KEYWORDS
  49. hash table, print, statistics
  50.